@interopio/desktop API Reference

Access via:io.appManager.myApplication

Describes an app.

Properties (19)

Property Type Default Required Description
allowMultiple⚓︎ boolean true

If true, the app can have multiple instances.
autoStart⚓︎ boolean x

If true, the app is auto started with the framework.
available⚓︎ boolean x

If true, the app is available and can be started.
caption⚓︎ string x

Caption of the app.
container⚓︎ string x

Container identifier.
hidden⚓︎ boolean false

If true, the app will be hidden in the io.Connect Launcher.
icon⚓︎ string x

App icon.
iconURL⚓︎ string x

URL of the app icon.
instances⚓︎ Instance[] x

Array of objects describing the running app instances.
isShell⚓︎ boolean false

If true, the app is a shell app.
keywords⚓︎ string[] x x

An array of keywords for discovering the app more easily.
mode⚓︎ WindowMode | "unknown" x

Mode of the app window. Possible values are "flat", "tab", "html" or "frameless". If the mode can't be determined (e.g., for external apps), the value is "unknown".
name⚓︎ string x

App name.
sortOrder⚓︎ number x

Sort indicator used when ordering apps in a list.
title⚓︎ string x

App title.
type⚓︎ string x

Type of the app.
userProperties⚓︎ PropertiesObject x

Custom configuration object attached to the app.
version⚓︎ string x

App version.
windowSettings⚓︎ WindowSettings x

Describes the settings for the app window.

8 Methods

getConfiguration()⚓︎

() => Promise<Definition>

Retrieves the app configuration.

onAvailable()⚓︎

(callback: (app: Application) => any) => UnsubscribeFunction

Notifies when the app becomes available.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

onChanged()⚓︎

(callback: (app: Application) => any) => void

Notifies when the app configuration is changed.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

onInstanceStarted()⚓︎

(callback: (instance: Instance) => any) => UnsubscribeFunction

Notifies when an instance of the app is started.

Parameters (1)

Name Type Required Description
callback⚓︎ (instance: Instance) => any

Callback function for handling the event.

onInstanceStopped()⚓︎

(callback: (instance: Instance) => any) => UnsubscribeFunction

Notifies when an instance of the app is stopped.

Parameters (1)

Name Type Required Description
callback⚓︎ (instance: Instance) => any

Callback function for handling the event.

onRemoved()⚓︎

(callback: (app: Application) => any) => void

Notifies when the app is removed.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

onUnavailable()⚓︎

(callback: (app: Application) => any) => UnsubscribeFunction

Notifies when the app becomes unavailable.

Parameters (1)

Name Type Required Description
callback⚓︎ (app: Application) => any

Callback function for handling the event.

start()⚓︎

(context?: object, options?: ApplicationStartOptions) => Promise<Instance>

Starts an instance of the app.

Parameters (2)

Name Type Required Description
context⚓︎ object x

Context to be passed to the started app instance.
options⚓︎ ApplicationStartOptions x

Options for the started app instance that will override the default app configuration.